fix: improve setup wizard and docs - #21
Merged
Merged
Conversation
- Add Claude Code CLI detection: --global uses `claude mcp add` when available - Add PII mode and dry-run prompts to the wizard - Create config directories if they don't exist (fixes ENOENT on fresh installs) - Restructure Getting Started docs: wizard first, manual config second - Clarify --local flag is for maintainers only - Update keychain docs to reflect `claude mcp add` support
Contributor
There was a problem hiding this comment.
Pull request overview
Improves the setup experience for configuring the Crystallize MCP server across Claude Code and Claude Desktop, and updates documentation to prioritize the interactive wizard and clarify maintainer-only flows.
Changes:
- Extends the setup wizard with PII mode + dry-run prompts and ensures config directories are created before writing.
- Adds Claude Code CLI detection for
--globalto preferclaude mcp addwhen available, with Desktop config fallback when not. - Restructures README Getting Started (wizard-first) and updates keychain + maintainer (
--local) guidance.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
tests/schema.test.ts |
Renames unused callback params to avoid linter no-shadow warnings. |
src/bin/setup.ts |
Adds PII/dry-run prompts, directory creation before writes, and Claude CLI-based global registration. |
README.md |
Reorders Getting Started to emphasize the wizard and updates Claude/keychain/maintainer documentation. |
.oxlintrc.json |
Enables no-shadow (warn) to catch shadowed identifiers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
istonejoeljonsson
added a commit
that referenced
this pull request
Apr 13, 2026
* 'main' of github.com:HayoDev/crystallize-mcp: chore(main): release crystallize-mcp 0.2.0 (#24) feat!: setup-wizard :nail-care: (#23) chore(main): release crystallize-mcp 0.1.10 (#22) fix: improve setup wizard and docs (#21) chore(main): release crystallize-mcp 0.1.9 (#20) feat: support content chunk updates with dot notation and fix richTex… (#18)
istonejoeljonsson
added a commit
that referenced
this pull request
Apr 13, 2026
* main: chore(main): release crystallize-mcp 0.2.0 (#24) feat!: setup-wizard :nail-care: (#23) chore(main): release crystallize-mcp 0.1.10 (#22) fix: improve setup wizard and docs (#21) chore(main): release crystallize-mcp 0.1.9 (#20) feat: support content chunk updates with dot notation and fix richTex… (#18)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
claude mcp addwhen availableclaude mcp addsupport